Cavern

Cavern4D

Cavernize

Debug

FilterInterfaces

Filters

Format

Helpers

QuickEQ

Remapping

SpecialSources

Spoofer

Utilities

Virtualizer

Atmosphere

AudioClip3D

AudioListener3D

AudioListener3DInspector

AudioSource3D

AddFilter(Filter)

clip

Clip

Clip3D

CopySettings(AudioSource3D)

DistanceSimulation

dopplerLevel

DopplerLevel

HasClip

isPlaying

IsPlaying

LFE

loop

Loop

mute

Mute

panStereo

Pause()

pitch

Pitch

Play(long)

PlayClipAtPoint(AudioClip, Vector3, float)

PlayDelayed(float)

PlayOneShot(AudioClip, float, bool)

RandomPosition

RemoveFilter(Filter)

SampleRate

Samples

Size

Source cavernSource

SourceUpdate()

spatialBlend

SpatialBlend

SpatialFilter

StereoPan

Stop()

time

timeSamples

TogglePlay()

UnPause()

volume

Volume

VolumeRolloff

CavernizeRealtime

Channel

Clip

Environments

Jack

Listener

QualityModes

Rolloffs

SeatAdaptation

Source

class AudioSource3D

An audio object in 3D space, in stereo, or both.

Visibility	Public
Extends	MonoBehaviour

Public functions

void AddFilter(Filter target)	Add a new SpatialFilter to this source.
void CopySettings(AudioSource3D from)	Copy the settings of another AudioSource3D.
void Pause()	Pause playback if it's not paused.
void Play(long delaySamples = 0)	Start playback from the beginning of the clip.
void PlayDelayed(float seconds)	Start playback from the beginning after the given time.
void PlayOneShot(AudioClip clip, float volume = 1, bool isStatic = false)	Play a clip once.
void RemoveFilter(Filter target)	Remove a SpatialFilter from this source.
void Stop()	Pause playback and reset position. The next UnPause will start playback from the beginning.
void TogglePlay()	Toggle between playback and pause.
void UnPause()	Continue playback if it's paused.

Public static functions

void PlayClipAtPoint(AudioClip clip, Vector3 position, float volume = 1)

Play a clip once at the given world position.

Protected functions

void SourceUpdate()

Synchronize this interface with cavernSource.

Public properties

AudioClip clip	Alias for Clip.
float dopplerLevel	Alias for DopplerLevel.
bool HasClip	True if the source has an active clip.
bool isPlaying	Alias for IsPlaying.
bool loop	Alias for Loop.
bool mute	Alias for Mute.
float panStereo	Alias for StereoPan.
float pitch	Alias for Pitch.
int SampleRate	Sample rate or -1 if there's no active clip.
int Samples	Sample count for a single channel or -1 if there's no active clip.
float spatialBlend	Alias for SpatialBlend.
float time	Clip playback position in seconds.
int timeSamples	Clip playback position in samples.
float volume	Alias for Volume.

Public variables

AudioClip Clip	The audio clip to play. If given, it will be converted to Cavern's Clip format.
Clip Clip3D	The audio clip to play in Cavern's format. Overrides Clip.
bool DistanceSimulation	Simulates distance, not just direction when using virtualization.
float DopplerLevel	Doppler effect scale, 1 is real.
bool IsPlaying	Continue playback of the source.
bool LFE	Only mix this channel to subwoofers.
bool Loop	Restart the source when finished.
bool Mute	Mute the source.
float Pitch	Playback speed with no pitch correction.
bool RandomPosition	Start playback from a random position.
float Size	Audio source size relative to Listener.EnvironmentSize. 0 is a point, 1 is the entire room.
float SpatialBlend	Balance between 1D and 3D mixing. 0 is 1D and 1 is 3D.
Filter SpatialFilter	Filter to be applied on the 3D mixed output.
float StereoPan	Balance between left and right channels.
float Volume	Source playback volume.
Rolloffs VolumeRolloff	Volume decreasing function by distance.

Protected variables

internal Source cavernSource

Cavern source handled by this component.

See also

CavernUnity DLL.Cavern.Helpers.ExternalSource	Handles and synchronizes an AudioSource3D with an input device.
CavernUnity DLL.Cavern.Helpers.ScaleByGain	Scale an object by an AudioSource3D's current gain.
CavernUnity DLL.Cavern.SpecialSources.InfiniteSource3D	An AudioSource3D with an intro Clip and a looping part after.
CavernUnity DLL.Cavern.Spoofer.AudioSourceSpoofer	Converts a regular AudioSource to Cavern's AudioSource3D.
CavernUnity DLL.Cavern.AudioListener3D	The center of the listening space. AudioSource3Ds will be rendered relative to this GameObject's position.
CavernUnity DLL.Cavern.AudioSource3D.CopySettings(AudioSource3D from)	Copy the settings of another AudioSource3D.